home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / pcboard / gifcol40.zip / GIFCOLL.DOC < prev    next >
Text File  |  1996-09-11  |  20KB  |  400 lines
  1.                 PCBoard 15.2+ GIF Collage Builder Command
  2.                         Version 4.0 Documentation
  3.  
  4.                            Earl Bonser, SysOp
  5.                             The GIFfer BBS
  6.                             4577 Gunn Highway
  7.                             Suite #170
  8.                             Tampa, Fl. 33624
  9.  
  10.                             Fido (1:377/50)
  11.  
  12.                         Internet: ebonser@gifl.com
  13.  
  14.                           BBS: (813) 969-2761
  15.  
  16. Note:  The current version of GIFColl is always available for FREQ using
  17. a magic name of GIFCOLL from 1:377/50 and is posted on the Salt Air BBS
  18. within 24 hours after being released.
  19.  
  20.  
  21. I hate lengthly doc's as much as anyone, so this will be kept as short
  22. and to the point as possible.  The GIF Collage processor is a PCBoard
  23. PPE command that allows your users to create a small GIF file that
  24. contains up to 9 reduced images of other GIF files.  By using this
  25. command, they can get a preview of what the GIF files look like before
  26. spending time downloading the individual GIF's.  As the operator of a
  27. large graphics oriented BBS, I soon realized that a lot of GIF's are not
  28. what they are described to be and quite a few of them get renamed,
  29. resulting in duplicates.  It is also quite common for multiple people to
  30. scan the same picture, once again resulting in duplicates.  This command
  31. will help your users to weed out the ones that they already have and not
  32. waste their time and bytes downloading unwanted GIF's.
  33.  
  34. GIFCOLL has been tested under PCBoard 15.1+, single node, multi node,
  35. DOS, Windows, WFW, Win95, Win/NT, OS/2 2.0, OS/2 2.1, Warp (won't work
  36. on a HPFS drive under OS/2!), DesqView and Lantastic.  It has been in
  37. use since June, 1993 and has yet to cause a system problem.  It is
  38. distributed as fully functional Freeware and may be posted or passed
  39. around in any way that you desire.  Registration to remove any delays
  40. and/or nags has been removed and GIFColl is completly free as of this
  41. release.  If you feel that this PPE is worth a few bucks, donate some $$
  42. or time to your local chapter of the Childrens Make a Wish foundation.
  43.  
  44. Installation of GIFCOLL is quick and simple.  The steps you should
  45. follow are given below.  You can get assistance if needed by contacting
  46. the author at The GIFfer BBS, sending Fido Netmail to Earl Bonser at
  47. Fido node 1:377/50 or Internet e-mail to ebonser@gifl.com.  Voice
  48. support is no longer provided since this is now freeware.  SysOp's that
  49. have already installed a PCBoard 15.x PPE will breeze thru the
  50. installation in only a few minutes.
  51.  
  52.  
  53.  
  54.                               INSTALLATION
  55.                               ============
  56.  
  57. If you are upgrading from a prior version you must reinstall completly
  58. except for changing your CMD.LST entry.
  59.  
  60. First a word for those of you running a dedicated single node system
  61. without the benefit of a multitasker.  You MAY need the DOS SHARE
  62. program loaded for this PPE to work.  This PPE is reading a file being
  63. held by PCBoard and will always report that there are no files flagged
  64. for download if you don't have SHARE or an equilavent program loaded.
  65. Just add the following line to your AUTOEXEC.BAT file.  If you are using
  66. a memory manager like QEMM, 386MAX or MemMaker the SHARE program can be
  67. loaded high with no loss to the lower 640k.
  68.  
  69.              C:\DOS\SHARE.EXE /F:name_space /L:numlocks
  70.  
  71.    Rules for SHARE: /F: - If you do not specify the /F switch, name_space
  72.                           is set to 2048 bytes.  Each open files uses 11
  73.                           bytes plus its full file specification (disk
  74.                           drive name, path name and file name).  This
  75.                           2048 bytes can contain 27 files that use all
  76.                           63 characters available for the full file name.
  77.                           I use /F:4096 on my system and have never had
  78.                           a problem that I am aware of.
  79.  
  80.                     /L: - If you do not specify the /L switch, a default
  81.                           of 20 simultaneous file locks are allowed.  I
  82.                           have found it best to set this to a value that
  83.                           is 5 more than the FILES=nnn value set in your
  84.                           CONFIG.SYS file.  (ie: use /L:55 for FILES=50).
  85.  
  86.  
  87. Step 1: Move all of the files into a single hard drive directory.  If
  88.         you are running a multi node system and/or a Lan, this must be
  89.         a directory that all of the nodes can access.  You can create
  90.         a new directory just for the GIFCOLL system or move the files
  91.         into any existing directory.  The following files should be
  92.         included:
  93.                    GIF          a PCBoard HELP file.
  94.                    GIFCOLL.PPE  the PCBoard command module
  95.                    GIFCOL1.EXE  a GIFCOLL sub command module
  96.                    GIFCOLL.DOC  this file
  97.                    GIFDESK.EXE  the GIFdesk collage builder utility
  98.                    GIFDESK.CMD  batch command string for GIFDesk
  99.                    HISTORY.TXT  change history log
  100.                    UPGRADE.DOC  install info for upgrading to new version
  101.  
  102. Step 2: Copy or move the GIF file to your PCBoard Help directory.  The
  103.         PCBoard Help directory is defined in PCBSetup B (File Locations)
  104.         A (System Files & Directories) "Location of Help Files".
  105.  
  106. Step 3: If you are running a multi node system, ensure that each node
  107.         specifies a unique directory for it's temporary work files in
  108.         PCBSetup B (File Locations), A (System Files & Directories)
  109.         "Location of Temporary Work Files".
  110.  
  111. Step 4: Ensure that there is plenty of space in the drive you have
  112.         specified as the location for temporary work files in PCBSetup
  113.         (see step #3 above).  GIFColl uses this directory to copy up
  114.         to 9 GIF's at a time into when makeing the collage.  Use of a
  115.         RAM drive, which is quite common for this directory, will speed
  116.         up processing but will cause unpredictable results if it is not
  117.         large enough.  The average GIF file runs between 150-250k, so
  118.         a drive with at least 3 meg of free space will suffice in
  119.         most cases.  You really should allow for GIF's as large as 500k
  120.         if possible (9 x 500k = 4.5 meg).  This directory is empty when
  121.         the GIF command is started (PCBoard has not put any files in it)
  122.         and GIFColl removes the files it placed in it when it ends.
  123.  
  124. Step 5: Select a directory that will be used for callers to download the
  125.         collage files from.  GIFColl will place the collage files in
  126.         this directory after they are built and remove them after the
  127.         caller downloads them.  It MUST be a directory that is included
  128.         as a Download Path in PCBSetup for each conference and should
  129.         NOT be an indexed directory.  It's also best to make it one of
  130.         the first directories in the Download Paths list in case one
  131.         of the names generated for the temporary collage file ends up
  132.         duplicating the name of a file already posted on your BBS.
  133.  
  134. Step 6: Add the GIFCOLL PPE to your PCBoard CMD.LST file.  Go into
  135.         PCBSetup, B (File Locations), B (Configuration Files), move the
  136.         highlight bar to "Name/Loc of Default CMD.LST File" and press
  137.         F2.  The following screen will be displayed.  Enter a command
  138.         specification line for the GIFColl PPE similar to this:
  139.  
  140.         Command   Security  PPE/MNU File -or- Keystroke Replacement
  141.         =======   ========  ==========================================
  142.         GIF          21     D:\PCB\GIFCOLL\GIFCOLL.PPE  D:\TEMP
  143.  
  144.     These usage of the fields on this screen are:
  145.  
  146.      - Command:
  147.         It is not required that the command name be GIF, but it is
  148.         highly recommended since it a short name and is also the name
  149.         of the help file.  If you use another name, do NOT rename the
  150.         help file.  You can copy it to the command name you use if
  151.         you wish so users can enter a "H name" command, but the
  152.         GIFCOLL PPE expects to find it under the name GIF in your
  153.         PCBoard Help directory.
  154.  
  155.      - Security:
  156.         You can specify any security level you want.  This is the
  157.         MINIMUM security level required for a caller to be able to
  158.         use this command.  You may want to set it at a level only
  159.         you or a few selected callers can use while testing it.
  160.  
  161.      - PPE/MNU File -or- Keystroke Replacement:
  162.        The location and name of the GIFCOLL.PPE and the location/name
  163.        of the DLPATH.LST identified download directory that the collage
  164.        files will be placed in for the user to download.  The collage
  165.        files will be deleted after the user downloads them.  This must
  166.        be a fully qualified path name (include drive letter) and must
  167.        not include an ending backslash (\).  If you have a "hidden"
  168.        directory like most of us sneeky snakes, it's ideal for this.
  169.  
  170.  
  171. Step 7: Add the GIF command to the PCBoard User's & Sysop's Menu(s)
  172.         specified in PCBSetup for each conference you wish to make
  173.         the command available in (normally BRDM & BRDS).
  174.  
  175. Step 8: Add a SET GIFDESK=FILE command to your AUTOEXEC.BAT file.
  176.         If you don't want to reboot just to test GIFCOLL, you can just
  177.         enter SET GIFDESK=FILE from the DOS command line prompt after
  178.         adding the command to your AUTOEXEC.BAT file.
  179.  
  180. Step 9: Add the following line to your $$LOGOFF.BAT file(s).
  181.  
  182.    IF EXIST d:\temp\C%PCBNODE%*.GIF delete d:\temp\C%PCBNODE%*.GIF
  183.  
  184.         This will clean up any collage files that may be left in your
  185.         download directory under some circumstances.  If the caller
  186.         select the (G)oodbye option when downloading the collage file,
  187.         the PPE is never reentered and the collage file is not deleted.
  188.         This will ensure that it is removed when the caller disconnects.
  189.  
  190. Step 10: If you are running a single node, it may be necessary for you
  191.          to add the following line to the start of your BOARD.BAT file.
  192.          PCBoard does not automatically build this environment variable
  193.          in some setups on single node systems (even if you are using
  194.          a multinode version like /2, /5, /10, etc.).  If you have set
  195.          the "Running in a multitask environment" switch in PCBSetup to
  196.          "N", you MUST either change it to "Y" or add the following line
  197.          to the begenning of your BOARD.BAT file.
  198.  
  199.          SET PCBNODE=1
  200.  
  201.  
  202. Now you can test it.  You can test it in local mode (a local signon),
  203. but you will not see exactly what a remote caller will see.  The PCBoard
  204. shell operations done by the GIFCOLL.PPE cause the screen to clear each
  205. time that one of the sub programs is invoked.  It's best to test it by
  206. calling your BBS like your users do.  You will be able to see the
  207. displays easier if you do.
  208.  
  209. Use of the GIF command is simple and self explanitory.  Just go into
  210. some of your file lists and flag some GIF files as though you were going
  211. to download them.  Then go back to the main menu and enter GIF.  The
  212. GIFCOLL.PPE will give you an estimate on how long it will take to create
  213. the collage file(s) and, if it thinks it will take more than 2 minutes,
  214. will ask you if you want to continue.  The time it actually takes will,
  215. naturally, depend on the speed of your processor and disk sub-system.
  216. It will then display information about the progress of the collage
  217. building process as it goes on.  If you have not flagged any GIF files
  218. for download before entering the GIF command, it will tell you so and
  219. display the GIF command Help file to instruct you on how to use it.
  220.  
  221. An entry is written to the PCBoard node log file each time that the GIF
  222. command is used.  This is done to assist you in keeping track of just
  223. how much the command is used and how usefull it is to your users.  There
  224. is another (sometimes irritating) feature that also lets you know how
  225. much the GIFCOLL PPE is being used.  The GIFDesk utility issues tones to
  226. your PC's speaker each time it has built a collage.  You will find this
  227. very irritating if you keep the hardware for your BBS close to or in
  228. your bedroom!  I hope to have this inconvience resolved in a future
  229. release of GIFCOLL.
  230.  
  231. The collage file(s) that are created for you are generated with random
  232. names (almost).  The format of the file names are:
  233.  
  234.        C1231234.GIF
  235.         ^^^||||----> A randomly generated number between 0-9999 that
  236.         ^^^          that will be incremented by 1 for each collage
  237.         ^^^          after the first one.
  238.         ^^^--------> The BBS node number.  The number of characters
  239.                      vary depending on the node number (ie: node 1
  240.                      is 1 character, node 10 is 2, etc.).
  241.  
  242. As you can see, it is possible for the generated name to duplicate the
  243. name of a file already posted on your BBS.  This, however, is very
  244. unlikley.  I recommend that the directory you specify for the collage
  245. files to be placed in for downloading be the first in your DLPATH.LST
  246. just in case it does happen to duplicate an existing file name.
  247.  
  248. Since the original reason I wrote the GIFCOLL.PPE was to help my callers
  249. not waste their time (and the BBS's time) and bytes getting something
  250. they really don't want, I make the collage files created by GIFColl free
  251. files on my BBS.  The time they use creating the collage files counts
  252. against their time limits, so it is not used by them as a way to get GIF
  253. pictures for free and beat the BBS restrictions on their sessions.  The
  254. GIFCOLL.PPE will also limit the number of GIF files it will process in a
  255. single invocation to 99.  If the user has flagged more than 99 GIF
  256. files, only the first 99 in the flag list will be processed.  This
  257. prevents 2 hours of building collage files for the guy that enters "FL
  258. *.GIF"!  He would probably hit his byte, time or file limit real quick
  259. anyway.  The way you set it up on your BBS is strictly your choice.  If
  260. you want to provide the collage files to your users without it counting
  261. against their byte or time/byte allotment, you can do the following:
  262.  
  263.     - Go into PCBSetup
  264.     - Select "File Locations" (B).
  265.     - Select "Configuration Files" (B).
  266.     - Move the highlight bar to "Name/Loc of FSEC file".
  267.     - Press F2 to edit the file as shown below.
  268.     - Press ESC to save the file.
  269.  
  270.            Drive \ Path             File Name    Sec      Password
  271.   =============================== ============= ===== =================
  272.   D:\TEMP\                        C*.GIF          20   NOTIME
  273.  
  274. These fields have the following meaning:
  275.  
  276.     - Drive\Path = The directory you specified as the dowload directory
  277.                    for the GIF collage files in CMD.LST.
  278.  
  279.     - File Name  = The name of the files that this entry applies to.
  280.                    If you wished to make the files free only on
  281.                    specific nodes, you could use a name mask that
  282.                    includes the node number (ie: C8*.GIF would make
  283.                    them free only on node #8).  You can also have
  284.                    multiple entries for multiple nodes if you wish.
  285.  
  286.     - Sec        = The lowest security level needed to have this setting
  287.                    apply to the caller.
  288.  
  289.     - Password   = A password of NOTIME means that downloading the
  290.                    file(s) is not counted as part of the session time
  291.                    and the download will not be counted against the
  292.                    callers download byte limit or file ratio.
  293.  
  294.                    A password of FREE means that downloading the file
  295.                    will not be charged against the callers download
  296.                    ratio.  The download time will still be deducted
  297.                    from the callers session time.
  298.  
  299.  
  300.                              COMMON PROBLEMS
  301.                              ===============
  302.  
  303. - I enter the command and nothing happens, the BBS just goes back to
  304.   the main menu!
  305.  
  306.   You have 1 of 2 problems.  Either you didn't install the PPE in the
  307.   directory you entered in the CMD.LST file or you don't have enough
  308.   memory available (probably under DesqView) for the GIFCOLL shell
  309.   operations.  You need about 200k of memory available when in PCBoard.
  310.   Look in the bottom right corner of the local screen to see how much
  311.   memory is available.
  312.  
  313. - I keep getting displays and messages in the node log file saying
  314.   "Download path not specified on PPE command line." and "GIF Collage
  315.   Processor Environment error - Inform your SysOp".
  316.  
  317.   Kinda self explanitory, isn't it?  You have either failed to include
  318.   the download path name in your CMD.LST file or the path does not
  319.   exist.
  320.  
  321. - Not all of the GIF's I have flagged are being included in the collage
  322.   or an error message is issued when the collage file is being moved to
  323.   the download directory.
  324.  
  325.   You probably don't have enough space in your PCBoard temporary work
  326.   file directory.  If the collage is empty, there isn't even enough
  327.   space for 1 of the GIF files to be held temporarialy.  If you are
  328.   getting some, but not all, of the GIF files in the collage then
  329.   there probably is not enough space on the drive.  A caviot here.
  330.   I think that the GIFDESK utility may have a problem processing GIF
  331.   files that are constructed with the GIF89a format.  Some of GIF
  332.   files using the GIF89a format may not be placed in a collage built
  333.   by GIFDESK.
  334.  
  335.  
  336. - A user aborts the download and then comes back to download the collage
  337.   files later but they are gone.
  338.  
  339.   That's correct.  The last thing that GIFCOLL does is clean up after
  340.   itself, including deletion of the collage files.  If you don't download
  341.   them when prompted to do so they are gone forever.
  342.  
  343.  
  344. - The GIF collage is being displayed on the local screen as the collage
  345.   is being built.
  346.  
  347.   The GIFDESK=FILE environment variable is not set.  Go back and look
  348.   at installation step #8 to remedy this.
  349.  
  350.  
  351. - My local screen keeps getting cleared when someone is using the GIF
  352.   command and I can't see what they are doing.
  353.  
  354.   PCBoard does this while shelled out to another program.  This occurs
  355.   in GIFColl when it is using some of it's sub-modules and when GIFDESK
  356.   is running.  All of the sub-modules are very quick, so this is kept
  357.   to a minimum.  It's actually nice to be able to see what GIFDESK is
  358.   doing since it gives you a progress report and shows the %complete
  359.   while building the collage.
  360.  
  361.  
  362. - The collage files are being left in the download directory and are
  363.   cluttering up my hard drive.
  364.  
  365.   You have not created or changed your $$LOGOFF.BAT as instructed in
  366.   installation step #9.
  367.  
  368.  
  369.  
  370.                               DISCLAIMER
  371.                               ==========
  372.  
  373. GIFCOLL by Earl Bonser is released to the general public as Freeware.
  374.  
  375. GIFCOLL is provided AS IS without any warranty, expressed or implied.
  376. This includes without limitation the fitfulness to a particular purpose
  377. or application and any warranties of merchantability.  While I tried to
  378. be as thorough as possible while debugging GIFCOLL, I shall not be
  379. liable for any damages, whether direct, indirect, special, or
  380. consequential arising from a failure of GIFCOLL to operate in a manner
  381. desired by the user. I shall not be liable for any damage to data or
  382. property which may by caused directly or indirectly by use of GIFCOLL.
  383. The only thing that I can gurantee is that it will use some space on
  384. your hard drive when you install it.
  385.  
  386. In no event will I be liable to you for any damages, including any lost
  387. profits, lost savings or other incidental or consequential damages
  388. arising out of your use, ability or inability to use the program, or for
  389. any claim by any other party.
  390.  
  391.  
  392.  
  393.                                 CREDITS
  394.                                 =======
  395.  
  396. PCBOARD is a registered trademark of Clark Development Company, Inc.
  397.  
  398. GIFDESK is an excellent program released as freeware by Jay Wherley.
  399.  
  400.